/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.apache.solr.search;

import org.apache.lucene.queryparser.xml.DOMUtils;
import org.apache.lucene.queryparser.xml.ParserException;
import org.apache.lucene.queryparser.xml.QueryBuilder;
import org.apache.lucene.queryparser.xml.builders.PointRangeQueryBuilder;
import org.apache.lucene.search.MultiTermQuery;
import org.apache.lucene.search.Query;
import org.apache.solr.legacy.LegacyNumericRangeQuery;
import org.apache.solr.legacy.LegacyNumericUtils;
import org.w3c.dom.Element;

/**
 * Creates a {@link org.apache.solr.legacy.LegacyNumericRangeQuery}. The table below specifies the
 * required attributes and the defaults if optional attributes are omitted. For more detail on what
 * each of the attributes actually do, consult the documentation for {@link
 * org.apache.solr.legacy.LegacyNumericRangeQuery}:
 *
 * <table>
 * <caption>supported attributes</caption>
 * <tr>
 * <th>Attribute name</th>
 * <th>Values</th>
 * <th>Required</th>
 * <th>Default</th>
 * </tr>
 * <tr>
 * <td>fieldName</td>
 * <td>String</td>
 * <td>Yes</td>
 * <td>N/A</td>
 * </tr>
 * <tr>
 * <td>lowerTerm</td>
 * <td>Specified by <code>type</code></td>
 * <td>No</td>
 * <td>Null</td>
 * </tr>
 * <tr>
 * <td>upperTerm</td>
 * <td>Specified by <code>type</code></td>
 * <td>No</td>
 * <td>Null</td>
 * </tr>
 * <tr>
 * <td>type</td>
 * <td>int, long, float, double</td>
 * <td>No</td>
 * <td>int</td>
 * </tr>
 * <tr>
 * <td>includeLower</td>
 * <td>true, false</td>
 * <td>No</td>
 * <td>true</td>
 * </tr>
 * <tr>
 * <td>includeUpper</td>
 * <td>true, false</td>
 * <td>No</td>
 * <td>true</td>
 * </tr>
 * <tr>
 * <td>precisionStep</td>
 * <td>Integer</td>
 * <td>No</td>
 * <td>4</td>
 * </tr>
 * </table>
 *
 * <p>A {@link ParserException} will be thrown if an error occurs parsing the supplied <code>
 * lowerTerm</code> or <code>upperTerm</code> into the numeric type specified by <code>type</code>.
 *
 * @deprecated Index with points and use {@link PointRangeQueryBuilder} instead
 */
@Deprecated
public class LegacyNumericRangeQueryBuilder implements QueryBuilder {

  @Override
  public Query getQuery(Element e) throws ParserException {
    String field = DOMUtils.getAttributeWithInheritanceOrFail(e, "fieldName");
    final String lowerTerm = DOMUtils.getAttribute(e, "lowerTerm", null);
    final String upperTerm = DOMUtils.getAttribute(e, "upperTerm", null);
    boolean lowerInclusive = DOMUtils.getAttribute(e, "includeLower", true);
    boolean upperInclusive = DOMUtils.getAttribute(e, "includeUpper", true);
    int precisionStep =
        DOMUtils.getAttribute(e, "precisionStep", LegacyNumericUtils.PRECISION_STEP_DEFAULT);

    String type = DOMUtils.getAttribute(e, "type", "int");
    try {
      Query filter;
      if (type.equalsIgnoreCase("int")) {
        filter =
            LegacyNumericRangeQuery.newIntRange(
                field,
                precisionStep,
                (lowerTerm == null ? null : Integer.valueOf(lowerTerm)),
                (upperTerm == null ? null : Integer.valueOf(upperTerm)),
                lowerInclusive,
                upperInclusive,
                MultiTermQuery.CONSTANT_SCORE_REWRITE);
      } else if (type.equalsIgnoreCase("long")) {
        filter =
            LegacyNumericRangeQuery.newLongRange(
                field,
                precisionStep,
                (lowerTerm == null ? null : Long.valueOf(lowerTerm)),
                (upperTerm == null ? null : Long.valueOf(upperTerm)),
                lowerInclusive,
                upperInclusive,
                MultiTermQuery.CONSTANT_SCORE_REWRITE);
      } else if (type.equalsIgnoreCase("double")) {
        filter =
            LegacyNumericRangeQuery.newDoubleRange(
                field,
                precisionStep,
                (lowerTerm == null ? null : Double.valueOf(lowerTerm)),
                (upperTerm == null ? null : Double.valueOf(upperTerm)),
                lowerInclusive,
                upperInclusive);
      } else if (type.equalsIgnoreCase("float")) {
        filter =
            LegacyNumericRangeQuery.newFloatRange(
                field,
                precisionStep,
                (lowerTerm == null ? null : Float.valueOf(lowerTerm)),
                (upperTerm == null ? null : Float.valueOf(upperTerm)),
                lowerInclusive,
                upperInclusive);
      } else {
        throw new ParserException("type attribute must be one of: [long, int, double, float]");
      }
      return filter;
    } catch (NumberFormatException nfe) {
      throw new ParserException("Could not parse lowerTerm or upperTerm into a number", nfe);
    }
  }
}
